FHIR Server FHIR Server Version n/a

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.insurance-card#current (78 ms)

Package

hl7.fhir.us.insurance-card

Type

CapabilityStatement

FHIR Version

Source

http://hl7.org/fhir/us/insurance-card/https://build.fhir.org/ig/HL7/carin-digital-insurance-card/CapabilityStatement-c4dic.html

Url

http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic

Version

1.1.0

Status

active

Date

2022-04-20

Name

InsuranceCardCapabilityStatement

Title

C4DIC CapabilityStatement

Experimental

False

Realm

Authority

hl7

Description

This Section describes the expected capabilities of the C4DIC Server actor which is responsible for providing responses to the queries submitted by the C4DIC Requestors.

Kind

requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide

hl7.fhir.us.insurance-card

CARIN Digital Insurance Card

http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage

C4DIC Coverage

http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization

C4DIC Organization

http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient

C4DIC Patient

Narrative

Note: links and images are rebased to the (stated) source

C4DIC CapabilityStatement

Official URL:http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic
Implementation Guide Version: 0.1.0
FHIR Version: 4.0.1
Intended Use: Requirements
Supported Formats: SHALL support JSON, SHOULD support XML
Supported Patch Formats: APPLICATION/JSON-PATCH+JSON
Published: 2022-04-20
Published by: HL7 Payer/Provider Information Exchange Working Group (PIE WG)
Status: Active

This Section describes the expected capabilities of the C4DIC Server actor which is responsible for providing responses to the queries submitted by the C4DIC Requestors.

Support the Following Implementation Guides:

http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card

FHIR Server RESTful Capabilities

The C4DIC Server SHALL:

Support all profiles defined in this Implementation Guide.
Implement the RESTful behavior according to the FHIR specification.
For all the supported search interactions in this guide, support the GET based search.
Return the following response classes: • (Status 400): invalid parameter • (Status 401/4xx): unauthorized request • (Status 403): insufficient scopes • (Status 404): unknown resource • (Status 410): deleted resource
Support json source formats for all profiles C4DIC interactions.
Identify the C4DIC profiles supported as part of the FHIR meta.profile attribute for each instance.
Support the searchParameters on each profile individually and in combination.

The C4DIC Server SHOULD:

Support xml source formats for all C4DIC interactions.

Security:

See the General Security Considerations section for requirements and recommendations.
A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.

RESTful Capabilities by Resource/Profile:

Summary

Resource Type Supported Interactions Supported Profiles Supported Searches Supported _includes Supported _revincludes Supported Operations

Coverage search-type, read, vread C4DIC-Coverage _id, _profile, _lastUpdated, beneficiary, subscriber, patient, identifier, period, status Coverage:beneficiary, Coverage:payor

Organization search-type, read, vread C4DIC-Organization _id

Patient search-type, read, vread C4DIC-Patient _id, _lastUpdated, identifier, name

Resource Type	Supported Interactions	Supported Profiles	Supported Searches	Supported `_includes`
Coverage	search-type, read, vread	C4DIC-Coverage	_id, _profile, _lastUpdated, beneficiary, subscriber, patient, identifier, period, status	Coverage:beneficiary, Coverage:payor
Organization	search-type, read, vread	C4DIC-Organization	_id
Patient	search-type, read, vread	C4DIC-Patient	_id, _lastUpdated, identifier, name

Coverage

Conformance Expectation: SHALL

Resource Specific Documentation:

Example query to search for Coverages which contain insurance card information: {baseurl}/Coverage?_profile=http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage

Supported Profiles:

C4DIC-Coverage

Reference Policy: resolves

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Coverage resource using: GET [base]/Coverage/[id]
A Server SHOULD be capable of returning a Coverage resource using: GET [base]/Coverage/[id]/_history/vid
A Server SHALL be capable of returning resources matching a search query using: GET [base]/Coverage/[id]{?[parameters]{&_format=[mime-type]}}
A Server (conformance expectation undefined) be capable of supporting the following _includes:
- Coverage:beneficiary - GET [base]/Coverage?[parameter=value]&_include=Coverage:beneficiary
- Coverage:payor - GET [base]/Coverage?[parameter=value]&_include=Coverage:payor

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id token GET [base]/Coverage?_id=[id]

SHALL _profile token GET [base]/Coverage?_profile=http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage

SHALL _lastUpdated reference GET [base]/Coverage?_lastUpdated=[dateTime]

SHALL beneficiary date GET [base]/Coverage?beneficiary=[beneficiary]

SHALL subscriber token GET [base]/Coverage?subscriber=[system]|[code]

SHALL patient token GET [base]/Coverage?patient=[system]|[code]

SHALL identifier date GET [base]/Coverage?identifier=[identifier]

SHALL period date GET [base]/Coverage?period=[period]

SHALL status token GET [base]/Coverage?status=[system]|[code]

Conformance	Parameter	Type	Example
SHALL	_id	token	`GET [base]/Coverage?_id=[id]`
SHALL	_profile	token	`GET [base]/Coverage?_profile=http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage`
SHALL	_lastUpdated	reference	`GET [base]/Coverage?_lastUpdated=[dateTime]`
SHALL	beneficiary	date	`GET [base]/Coverage?beneficiary=[beneficiary]`
SHALL	subscriber	token	`GET [base]/Coverage?subscriber=[system]\|[code]`
SHALL	patient	token	`GET [base]/Coverage?patient=[system]\|[code]`
SHALL	identifier	date	`GET [base]/Coverage?identifier=[identifier]`
SHALL	period	date	`GET [base]/Coverage?period=[period]`
SHALL	status	token	`GET [base]/Coverage?status=[system]\|[code]`

Organization

Conformance Expectation: SHALL

Supported Profiles:

C4DIC-Organization

Reference Policy: resolves

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread.

Fetch and Search Criteria:

A Server SHALL be capable of returning an Organization resource using: GET [base]/Organization/[id]
A Server SHOULD be capable of returning an Organization resource using: GET [base]/Organization/[id]/_history/vid
A Server SHALL be capable of returning resources matching a search query using: GET [base]/Organization/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id reference GET [base]/Organization?_id=[id]

Conformance	Parameter	Type	Example
SHALL	_id	reference	`GET [base]/Organization?_id=[id]`

Patient

Conformance Expectation: SHALL

Supported Profiles:

C4DIC-Patient

Reference Policy: resolves

Profile Interaction Summary:

SHALL support search-type, read.
SHOULD support vread.

Fetch and Search Criteria:

A Server SHALL be capable of returning a Patient resource using: GET [base]/Patient/[id]
A Server SHOULD be capable of returning a Patient resource using: GET [base]/Patient/[id]/_history/vid
A Server SHALL be capable of returning resources matching a search query using: GET [base]/Patient/[id]{?[parameters]{&_format=[mime-type]}}

Search Parameter Summary:

Conformance Parameter Type Example

SHALL _id reference GET [base]/Patient?_id=[id]

SHALL _lastUpdated reference GET [base]/Patient?_lastUpdated=[dateTime]

SHALL identifier reference GET [base]/Patient?identifier=[type]/[id]

SHALL name reference GET [base]/Patient?name=[type]/[id]

Conformance	Parameter	Type	Example
SHALL	_id	reference	`GET [base]/Patient?_id=[id]`
SHALL	_lastUpdated	reference	`GET [base]/Patient?_lastUpdated=[dateTime]`
SHALL	identifier	reference	`GET [base]/Patient?identifier=[type]/[id]`
SHALL	name	reference	`GET [base]/Patient?name=[type]/[id]`

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "c4dic",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">C4DIC CapabilityStatement</h2><ul><li><b>Official URL:</b><code>http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic</code></li><li><b>Implementation Guide Version:</b> 0.1.0</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats:</b>\n\t\t\t\t\n                    <b>SHALL</b> support JSON, <b>SHOULD</b> support XML\n\t\t\t\t\n\t\t\t\t</li><li><b>Supported Patch Formats:</b>\n\t\t\t\t\n                    APPLICATION/JSON-PATCH+JSON\n\t\t\t\t\n\t\t\t\t</li><li><b>Published:</b> 2022-04-20</li><li><b>Published by:</b> HL7 Payer/Provider Information Exchange Working Group (PIE WG)</li><li><b>Status:</b> Active</li></ul><p>This Section describes the expected capabilities of the C4DIC Server actor which is responsible for providing responses to the queries submitted by the C4DIC Requestors.</p>  <!-- No support expectation extension --><h3 id=\"igs\" class=\"no_toc\">Support the Following Implementation Guides:</h3><ul><li><a href=\"http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card\">http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card</a></li></ul>  <!-- REST Behavior --><h3 id=\"behavior\">FHIR Server RESTful Capabilities</h3><p>The C4DIC Server <strong>SHALL</strong>:</p><ol><li>Support all profiles defined in this Implementation Guide.</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>For all the supported search interactions in this guide, support the GET based search.</li><li>Return the following response classes:\nâ€¢\t(Status 400): invalid parameter\nâ€¢\t(Status 401/4xx): unauthorized request\nâ€¢\t(Status 403): insufficient scopes\nâ€¢\t(Status 404): unknown resource\nâ€¢\t(Status 410): deleted resource</li><li>Support json source formats for all profiles C4DIC interactions.</li><li>Identify the C4DIC profiles supported as part of the FHIR meta.profile attribute for each instance.</li><li>Support the searchParameters on each profile individually and in combination.</li></ol><p>The C4DIC Server <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all C4DIC interactions.</li></ol><p id=\"security\"><strong>Security:</strong></p><ol><li>See the <a href=\"Authorization_Authentication_and_Registration.html\">General Security Considerations</a> section for requirements and recommendations.</li><li>A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li></ol><h3 id=\"resource--details\" class=\"no_toc\">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary</strong></p><table class=\"grid\"><thead><tr><th>Resource Type</th><th>Supported Interactions</th><th>Supported Profiles</th><th>Supported Searches</th><th>Supported <code>_includes</code></th><th>Supported <code>_revincludes</code></th><th>Supported Operations</th></tr></thead><tbody><tr><td><a href=\"#coverage\">Coverage</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tsearch-type, \n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tread, \n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tvread\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage\">C4DIC-Coverage</a></td>  <!-- Supported Searches --><td>\n\t\t\t\t\t\t\t\t\t\t_id, _profile, _lastUpdated, beneficiary, subscriber, patient, identifier, period, status\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported _includes --><td>\n\t\t\t\t\t\t\t\t\t\tCoverage:beneficiary, Coverage:payor\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported _revincludes --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported Operations --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td></tr><tr><td><a href=\"#organization\">Organization</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tsearch-type, \n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tread, \n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tvread\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization\">C4DIC-Organization</a></td>  <!-- Supported Searches --><td>\n\t\t\t\t\t\t\t\t\t\t_id\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported _includes --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported _revincludes --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported Operations --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td></tr><tr><td><a href=\"#patient\">Patient</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tsearch-type, \n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tread, \n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\tvread\n\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported Profiles --><td><a href=\"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient\">C4DIC-Patient</a></td>  <!-- Supported Searches --><td>\n\t\t\t\t\t\t\t\t\t\t_id, _lastUpdated, identifier, name\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported _includes --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported _revincludes --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td>  <!-- Supported Operations --><td>\n\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t</td></tr></tbody></table>  <!-- Resource Details --><h4 id=\"coverage\" class=\"no_toc\">Coverage</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Resource Specific Documentation:</p><p>Example query to search for Coverages which contain insurance card information: {baseurl}/Coverage?_profile=http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage</p><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage\">C4DIC-Coverage</a></li></ul><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Coverage resource using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Coverage/[id]</code>\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t</li><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Coverage resource using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Coverage/[id]/_history/vid</code>\n\t\t\t\t\t\t\t\t\t\t\t</li><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning resources matching a search query using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Coverage/[id]{?[parameters]{&amp;_format=[mime-type]}}</code>\n\t\t\t\t\t\t\t\t\t\t\t</li><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>(conformance expectation undefined)</strong> be capable of supporting the following _includes:\n\t\t\t\t\t\t\t\t\t\t\t\t<ul><li>Coverage:beneficiary - <code class=\"highlighter-rouge\">GET [base]/Coverage?[parameter=value]&amp;_include=Coverage:beneficiary</code></li><li>Coverage:payor - <code class=\"highlighter-rouge\">GET [base]/Coverage?[parameter=value]&amp;_include=Coverage:payor</code></li></ul>\n\t\t\t\t\t\t\t\t\t\t\t</li></ul>  <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t_id</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t_profile</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?_profile=http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t_lastUpdated</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\treference\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tbeneficiary</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?beneficiary=[beneficiary]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tsubscriber</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?subscriber=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tpatient</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?patient=[system]|[code]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tidentifier</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?identifier=[identifier]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tperiod</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tdate\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?period=[period]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/coverage.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tstatus</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ttoken\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Coverage?status=[system]|[code]</code></td></tr></tbody></table><h4 id=\"organization\" class=\"no_toc\">Organization</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization\">C4DIC-Organization</a></li></ul><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning an Organization resource using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Organization/[id]</code>\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t</li><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning an Organization resource using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Organization/[id]/_history/vid</code>\n\t\t\t\t\t\t\t\t\t\t\t</li><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning resources matching a search query using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Organization/[id]{?[parameters]{&amp;_format=[mime-type]}}</code>\n\t\t\t\t\t\t\t\t\t\t\t</li></ul>  <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t_id</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\treference\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Organization?_id=[id]</code></td></tr></tbody></table><h4 id=\"patient\" class=\"no_toc\">Patient</h4><p>Conformance Expectation:\t<strong>SHALL</strong></p><p>Supported Profiles:</p><ul><li><a href=\"http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient\">C4DIC-Patient</a></li></ul><p>Reference Policy: <code>resolves</code></p><p>Profile Interaction Summary:</p><ul><li><strong>SHALL</strong> support \n\t\t\t\t\t\t\t\t\t\t\t<code>search-type</code>, \n\t\t\t\t\t\t\t\t\t\t\t<code>read</code>.</li><li><strong>SHOULD</strong> support \n\t\t\t\t\t\t\t\t\t\t\t<code>vread</code>.</li></ul><p>Fetch and Search Criteria:</p><ul><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning a Patient resource using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Patient/[id]</code>\n\t\t\t\t\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t\t\t</li><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHOULD</strong> be capable of returning a Patient resource using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Patient/[id]/_history/vid</code>\n\t\t\t\t\t\t\t\t\t\t\t</li><li>\n\t\t\t\t\t\t\t\t\t\t\t\tA Server <strong>SHALL</strong> be capable of returning resources matching a search query using:\n\t\t\t\t\t\t\t\t\t\t\t\t<code class=\"highlighter-rouge\">GET [base]/Patient/[id]{?[parameters]{&amp;_format=[mime-type]}}</code>\n\t\t\t\t\t\t\t\t\t\t\t</li></ul>  <!-- Only included search parameters that are not MAY or there is no conformance requirement included --><p>Search Parameter Summary:</p><table class=\"grid\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Example</th></tr></thead><tbody><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#id\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t_id</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\treference\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?_id=[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/search.html#lastUpdated\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t_lastUpdated</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\treference\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?_lastUpdated=[dateTime]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tidentifier</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\treference\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?identifier=[type]/[id]</code></td></tr><tr><td><strong>SHALL</strong></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\tname</a></td><td>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\treference\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t</td><td><code class=\"highlighter-rouge\">GET [base]/Patient?name=[type]/[id]</code></td></tr></tbody></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "claims"
    }
  ],
  "url" : "http://hl7.org/fhir/us/insurance-card/CapabilityStatement/c4dic",
  "version" : "1.1.0",
  "name" : "InsuranceCardCapabilityStatement",
  "title" : "C4DIC CapabilityStatement",
  "status" : "active",
  "experimental" : false,
  "date" : "2022-04-20",
  "publisher" : "HL7 International / Payer/Provider Information Exchange Work Group",
  "contact" : [
    {
      "name" : "HL7 International / Payer/Provider Information Exchange Work Group",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/claims"
        },
        {
          "system" : "email",
          "value" : "pie@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "This Section describes the expected capabilities of the C4DIC Server actor which is responsible for providing responses to the queries submitted by the C4DIC Requestors.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json",
    "xml"
  ],
  "_format" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }
      ]
    },
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHOULD"
        }
      ]
    }
  ],
  "patchFormat" : [
    "application/json-patch+json"
  ],
  "implementationGuide" : [
    "http://hl7.org/fhir/us/insurance-card/ImplementationGuide/hl7.fhir.us.insurance-card"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The C4DIC Server **SHALL**:\n\n1.\tSupport all profiles defined in this Implementation Guide.\n2.\tImplement the RESTful behavior according to the FHIR specification.\n3.\tFor all the supported search interactions in this guide, support the GET based search.\n4.\tReturn the following response classes:\nâ€¢\t(Status 400): invalid parameter\nâ€¢\t(Status 401/4xx): unauthorized request\nâ€¢\t(Status 403): insufficient scopes\nâ€¢\t(Status 404): unknown resource\nâ€¢\t(Status 410): deleted resource\n5.\tSupport json source formats for all profiles C4DIC interactions.\n6.\tIdentify the C4DIC profiles supported as part of the FHIR meta.profile attribute for each instance.\n7.\tSupport the searchParameters on each profile individually and in combination.\n\nThe C4DIC Server **SHOULD**:\n\n1.\tSupport xml source formats for all C4DIC interactions.",
      "security" : {
        "description" : "1. See the [General Security Considerations](Authorization_Authentication_and_Registration.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Coverage",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Coverage"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchInclude" : [
            "Coverage:beneficiary",
            "Coverage:payor"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_profile",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "beneficiary",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "subscriber",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "patient",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "period",
              "type" : "date"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "status",
              "type" : "token"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Organization",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Organization"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "type" : "reference"
            }
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Patient",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/insurance-card/StructureDefinition/C4DIC-Patient"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_id",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "_lastUpdated",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "type" : "reference"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.